Inside Macintosh: QuickDraw GX Printing /

Chapter 3 - Page Formatting and Dialog Box Customization / Page Formatting and Dialog Box Customization Reference

Constants and Data Types for Job Collection Items

Print-Job Information

The collection item ID for print-job information is defined in the following enumeration:

enum { gxJobTag = 'job ' };

QuickDraw GX stores print-job information in the gxJobInfo structure:

struct gxJobInfo {
   long     numPages;         
   long     priority;         
   long     timeToPrint;      
   long     jobTimeout;       
   long     firstPageToPrint  
   short    jobAlert;         
   Str31    appName;          
   Str31    documentName;     
   Str31    userName;         
};

Field Description

numPages

The total number of pages to print. The user specifies the page range to print in the Print dialog box.

priority

The print job's priority. Priorities for print jobs are defined in the print-job priorities enumeration. The user specifies the priority for a print job in the Print Time panel.

timeToPrint

The designated time to print a print job. The user specifies a designated printing time in the Print Time panel.

jobTimeout

The time to cancel the print job, in ticks. QuickDraw GX defines two print-job cancelation times in the print-job cancelation enumeration.

firstPageToPrint

The first page to begin printing.

jobAlert

When to alert the user about printing. QuickDraw GX defines print job alerts in the print-job alert enumeration.

appName

A string containing the name of the application used to create the printable document.

documentName

A string containing the name of the user's document.

userName

A string containing the name of the user associated with the printable document.

QuickDraw GX defines priorities for print jobs in the print-job priorities enumeration:

enum {
   gxPrintJobUrgent  = 0x00000001,  
   gxPrintJobAtTime  = 0x00000002,  
   gxPrintJobASAP    = 0x00000003   
};

Constant descriptions

gxPrintJobUrgent

If set, QuickDraw GX designates a print job as "urgent."

gxPrintJobAtTime

If set, QuickDraw GX designates the time to print a print job.

gxPrintJobASAP

If set, QuickDraw GX designates a print job as "as soon as possible."

A holding bit for print-job priorities is defined in the following enumeration:

enum { gxPrintJobHoldingBit = 0x00001000 };

QuickDraw GX defines holding status for print jobs in the holding status enumeration:

enum {
   gxPrintJobHolding       = (gxPrintJobHoldingBit + 
                              gxPrintJobASAP),
   gxPrintJobHoldingAtTime = (gxPrintJobHoldingBit + 
                              gxPrintJobAtTime),
   gxPrintJobHoldingUrgent = (gxPrintJobHoldingBit + 
                              gxPrintJobUrgent)
};

Constant descriptions

gxPrintJobHolding

If set, QuickDraw GX assigns a print job designated as "as soon as possible" to a holding status.

gxPrintJobHoldingAtTime

If set, QuickDraw GX assigns a print job designated to print at a specific time to a holding status.

gxPrintJobHoldingUrgent

If set, QuickDraw GX assigns a print job designated as "urgent" to a holding status.

QuickDraw GX defines print job alerts in the print-job alert enumeration:

enum {
   gxNoPrintTimeAlert=  0,    
   gxAlertBefore     =  1,    
   gxAlertAfter      =  2,    
   gxAlertBothTimes  =  3     
};

Constant descriptions

gxNoPrintTimeAlert

If set, QuickDraw GX doesn't alert the user about printing.

gxAlertBefore

If set, QuickDraw GX alerts the user that printing is about to begin.

gxAlertAfter

If set, QuickDraw GX alerts the user that printing has finished.

gxAlertBothTimes

If set, QuickDraw GX alerts the user when printing begins and finishes.

QuickDraw GX defines two print-job cancelation times in the print-job cancelation enumeration, which you could use if the user failed to respond to a condition, such as out of paper:

enum {
   gxThirtySeconds   =  1800, 
   gxTwoMinutes      =  7200  
};

Constant descriptions

gxThirtySeconds

If set, QuickDraw GX cancels a print job in 30 seconds, or 1800 ticks.

gxTwoMinutes

If set, QuickDraw GX cancels a print job in 2 minutes, or 7200 ticks.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help